<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN">
<html>
<head>
<title>SYS_CONSOLE_Write Function</title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="generator" content="Doc-O-Matic" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <link rel="STYLESHEET" href="default.css" type="text/css" />

<script type="text/javascript" src="scripts.js"></script>
</head>
<body class="Element700" onload="onBodyLoadEx('frames.html', 'topic', '00850.html');" onmousedown="onBodyMouseDown();">

<!-- Begin Popups -->

<!-- End Popups -->

<!-- Begin Page Header -->
<div class="Element710" id="areafixed">
<div class="Element94">
<a href="01259.html" target="topic">System Service Libraries Help</a> &gt; <a href="00704.html" target="topic">Console System Service Library Help</a> &gt; <a href="00705.html" target="topic">Library Interface</a> &gt; b) Core Functions &gt; <a href="00850.html" target="topic">SYS_CONSOLE_Write Function</a></div>
<div class="Element92">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element1">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element2">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element90">
<a href="00842.html" target="topic">Previous</a> | <a href="00705.html" target="topic">Up</a> | <a href="00851.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element96">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: SYS_CONSOLE_Write@SYS_CONSOLE_HANDLE@void*@size_t Topic Title: SYS_CONSOLE_Write Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table><div class="Element5">
SYS_CONSOLE_Write Function</div>
</div>
</div>

<!-- End Page Header -->

<!-- Begin Client Area -->
<div class="Element720" id="areascroll">
<div class="Element721">

<!-- Begin Page Content -->
<a name="PageContent"></a><div class="Element58">
<a name="4465736372697074696F6E"></a><div class="Element11">
<div class="Element10">
<p class="Element10">
This function writes data to the console device. The function performs a deep-copy of the data passed in buf.</p></div>
</div>
<a name="43"></a><div class="Element99">
C</div>
<div class="Element101"><div class="Element100"><pre class="Element100">ssize_t <strong><span style="color: #000000">SYS_CONSOLE_Write</span></strong>(
    <strong><span style="color: #000080">const</span></strong> <a href="00832.html" target="topic">SYS_CONSOLE_HANDLE</a> <strong><span style="color: #000000">handle</span></strong>, 
    <strong><span style="color: #000080">const</span></strong> <strong><span style="color: #000080">void</span></strong>* <strong><span style="color: #000000">buf</span></strong>, 
    size_t <strong><span style="color: #000000">count</span></strong>
);</pre></div></div>
<a name="507265636F6E646974696F6E73"></a><div class="Element14">
Preconditions</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
The <a href="00835.html" target="topic">SYS_CONSOLE_Initialize</a> function should have been called before calling this function.</p></div>
</div>
<a name="506172616D6574657273"></a><div class="Element14">
Parameters</div>
<div class="Element11">
<div class="Element10">
<div class="Element312">
<div class="TableDiv">
<table cellspacing="0" class="Table3">
<tr>
<td class="Element300" valign="top" width="35%">
<div class="Element301">
Parameters&nbsp;</div></td><td class="Element304" valign="top" width="65%">
<div class="Element305">
Description&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
handle&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Handle to the console instance&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
buf&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Buffer holding the data to be written.&nbsp;</div></td></tr><tr>
<td class="Element302" valign="top" width="35%">
<div class="Element303">
count&nbsp;</div></td><td class="Element306" valign="top" width="65%">
<div class="Element307">
Number of bytes to write.&nbsp;</div></td></tr></table></div></div>
</div>
</div>
<a name="52657475726E73"></a><div class="Element14">
Returns</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
The return value indicates the number of bytes accepted by the function. In case the return value is less than the count value, the application must try to send the remaining bytes in next attempt(s). Returns -1 in case of any error.</p></div>
</div>
<a name="52656D61726B73"></a><div class="Element14">
Remarks</div>
<div class="Element11">
<div class="Element10">
<p class="Element10">
Application may check the free space available in the transmit buffer by calling the <a href="00852.html" target="topic">SYS_CONSOLE_WriteFreeBufferCountGet</a>() API.</p></div>
</div>
<a name="4578616D706C65"></a><div class="Element14">
Example</div>
<div class="Element11">
<div class="Element10">
<div class="Element13"><div class="Element12"><pre class="Element12">ssize_t nr;
<strong><span style="color: #000080">char</span></strong> myBuffer[] = &quot;message&quot;;
<a href="00832.html" target="topic">SYS_CONSOLE_HANDLE</a> myConsoleHandle;

<i><span style="color: #008000">// myConsoleHandle is assumed to be a valid console handle</span></i>
nr = SYS_CONSOLE_Write( myConsoleHandle, myBuffer, strlen(myBuffer) );
<strong><span style="color: #000080">if</span></strong> (nr == -1)
{
    <i><span style="color: #008000">// Handle error</span></i>
}
<strong><span style="color: #000080">if</span></strong> (nr != strlen(myBuffer))
{
    <i><span style="color: #008000">// Try send the remaining data after some time.</span></i>
}</pre></div></div>
</div>
</div>
</div>
<!-- End Page Content -->

<!-- Begin Page Footer -->
<div class="Element95">
<a href="01259.html" target="topic">System Service Libraries Help</a> &gt; <a href="00704.html" target="topic">Console System Service Library Help</a> &gt; <a href="00705.html" target="topic">Library Interface</a> &gt; b) Core Functions &gt; <a href="00850.html" target="topic">SYS_CONSOLE_Write Function</a></div>
<div class="Element93">
<table width="100%" cellspacing="0" cellpadding="0">
<tr><td width="25%">
<div class="Element3">
MPLAB Harmony Core Help</div>
</td><td width="25%">
<div class="Element4">
<a href="contents.html" target="tocidx">Contents</a> | <a href="00007.html" target="topic">Home</a></div>
</td><td width="25%">
<div class="Element91">
<a href="00842.html" target="topic">Previous</a> | <a href="00705.html" target="topic">Up</a> | <a href="00851.html" target="topic">Next</a></div>
</td><td width="25%">
<div class="Element97">
<a href="mailto:docerrors@microchip.com&subject=MPLAB Harmony Documentation Feedback (Topic ID: SYS_CONSOLE_Write@SYS_CONSOLE_HANDLE@void*@size_t Topic Title: SYS_CONSOLE_Write Function)&body=Thank you for your feedback! Please include a description of your feedback, and indicate whether you are reporting an an error in the documentation or an enhancement.">Documentation Feedback</a><br> <a href="http://support.microchip.com" target="_blank">Microchip Support</a></div>
</td></tr></table></div>

<!-- End Page Footer -->
</div>
</div>

<!-- End Client Area -->
</body></html>